Proper configuration of the docuRob ® WorkFlow product ensures its correct and efficient use. To do this, you must familiarize yourself with the description of the individual configuration elements such as the structure of configuration files and the configuration parameters.

Configuration files

docuRob ® WorkFlow configuration is based on a set of files located (after installation) in the resources directory (i.e. < docuRob ® WorkFlow installation directory >/reosources). Table 3 lists the files and the product modules they initiate.

File	Product module
ooworkflow.properties	access to the repository Automated Tasks Agent event handling delay signaling logging information about system operation process instance archive management
oorm.properties	Resource Management

Table 3 : docuRob®WorkFlow configuration files

Basic parameters

This section describes the basic parameters of the docuRob ® WorkFlow product . For each parameter, its meaning is described and a set of possible values and a default value are provided.

Access to the repository

The repository access configuration is contained in the ooworkflow.properties file and consists of the following parameters:

• datasource.jdbc.driver – the JDBC driver used - the name of the driver class implementing the JDBC interfaces
• datasource.jdbc.path - URL connection string specification according to the recommendations for the given driver
• datasource.jdbc.username - the name of the internal database user who has access to the system data. Most often, it is the login of the owner of the schema on which the system database structure was created
• datasource.jdbc.password - internal database user password

Automated Task Agent

The configuration of the agent performing automatic tasks is contained in the ooworkflow.properties file and consists of the following parameters:

• sysperformer – enable/disable automatic tasks; possible values: ON - enabled, OFF - disabled
• sysperformer.cleanMissingExecutorsInterval – interval for verifying available threads executing automatic tasks; value – number of seconds
• sysperformer.killExpiredOwnTasksInterval – the interval to search for tasks that have exceeded the allowed execution time (see the sysperformer.maxExecutionTime parameter ) within the current node
• sysperformer.killExpiredTasksInterval - the interval for searching for tasks that have exceeded the allowed execution time (see the sysperformer.maxExecutionTime parameter ) across all nodes in the cluster
• sysperformer.checkNewTasksInterval - interval for searching for new tasks to perform
• sysperformer.checkOldTasksInterval - interval to search for postponed tasks
• sysperformer.idleTime – idle time
• sysperformer.maxExecutionTime – maximum time allowed for task execution
• sysperformer.maxSimultaneousExecutors – number of threads executing tasks in parallel

Event handling

The configuration of handling events generated by docuRob ® WorkFlow is contained in the ooworkflow.properties file and consists of the following parameters:

• events – enable/disable event generation; possible values – ON, OFF respectively
• events.listeners – a comma-separated list of <name> listener class names
• events.listeners .<name> - the full name of the Java class (FQN) that implements the specific docuRob ® WorkFlow API ( pl.rodan.ooworkflow.environment.event.WfEventHandler ), which allows listening to events

To enable event listening for the example class com.mysystem.EventsListener , you need to enable event generation (1), define a listening class (3) and activate its listening (2):

• events = ON
• events.listeners = my_listener
• events.listeners. my_listener = com.mysystem.EventsListener

Delay signaling

The delay signaling mechanism enables docuRob ® WorkFlow to monitor process time limits and signal when they are exceeded. The following parameters allow you to configure delay signaling:

1. notification.system – enable/disable delay signaling; allowable values are ON, OFF, respectively
2. notification.system.timeslice – interval between subsequent readings of the time constraints status; time given in minutes

Logging information about system operation

Logging information about the system operation is based on the Log4j library ¹. The following parameters of the ooworkflow.properties file allow you to configure the logging mechanism:

• logger.parameters.file.type - file type where the Log4j library configuration is saved; Allowed types are text (txt value) and XML document ( xml value )
• logger.parameters.file - path and name of the configuration file. If the parameter has the value this , it means that the Log4j library configuration is included in the current file

Resource Management

docuRob ® WorkFlow obtains information about external resources – users, user groups, occupied positions – from the implementation of three interfaces, the configuration of which – pointing to the implementing classes – is located in the oorm.properties file .

• WfRMUserProcess – indicates the implementation of the user recovery interface ( pl.rodan.ooworkflow.environment.wfRM.WfRMUserProcess )
• WfRMGroupProcess - indicates the implementation of the interface for recovering user groups ( pl.rodan.ooworkflow.environment.wfRM.WfRMGroupProcess )
• WfRMUserPositionProcess - indicates the implementation of the interface for retrieving positions occupied by users ( pl.rodan.ooworkflow.environment.wfRM.WfRMUserPositionProcess )

Two implementations of the above interfaces are provided as standard – the first one allows you to retrieve data from the database based on views, while the second one searches for information from an instance of the ontology management product docuRob ® OntologyManager . During the operation of docuRob ® WorkFlow , only one set of implementations of the above interfaces can be active. In the oorm.properties file , each implementation is preceded by a prefix – db or tm , respectively – for database views and ontologies. The active implementation is selected in the ooworkflow.properties file by setting the parameter:

• oorm.impl – allowed values: db , tm

when selecting tm, you must additionally configure access to the docuRob ® OntologyManager server by setting two parameters also in the ooworkflow.properties file :

• topicmaps.host – address of the ontology management server
• topicmaps.port – ontology management server port

Process Instance Archive Management

In order to reduce the space occupied by instances of completed processes in the repository, it is possible to archive them. Archiving a process instance consists of exporting it to an external resource. Within the repository, only a "trace" remains, which allows for the recovery of the process instance (import from the archive). The archive manager configuration consists in indicating in the ooworkflow.properties file the full name of the Java class (FQN), which implements the pl.rodan.ooworkflow.environment.archive.WfArchiveManager interface :

• WfArchiveManager – indicates the implementation of the archive manager interface

Other parameters

docuRob ® WorkFlow requires changing the default memory settings used by the Java Virtual Machine (JVM), i.e. increasing the initial maximum JVM heap size ( heap size ) to 256 megabytes :

-Xmx256m

Footnotes

1. Log4j - http://logging.apache.org/log4j/ ↩